<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package maze.model;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.awt.Dimension;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.awt.Point;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.io.Serializable;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    /**<a name="line.7"></a>
<FONT color="green">008</FONT>     * Represents the coordinates of one cell/box of the maze. &lt;br&gt;<a name="line.8"></a>
<FONT color="green">009</FONT>     * The upper left is x = 1, y = 1.&lt;br&gt;<a name="line.9"></a>
<FONT color="green">010</FONT>     * Each instance is immutable.<a name="line.10"></a>
<FONT color="green">011</FONT>     */<a name="line.11"></a>
<FONT color="green">012</FONT>    public final class MazeCell implements Comparable&lt;MazeCell&gt;, Serializable<a name="line.12"></a>
<FONT color="green">013</FONT>    {<a name="line.13"></a>
<FONT color="green">014</FONT>       private static final long serialVersionUID = -3456709665929349825L;<a name="line.14"></a>
<FONT color="green">015</FONT>    <a name="line.15"></a>
<FONT color="green">016</FONT>       /**<a name="line.16"></a>
<FONT color="green">017</FONT>        * The column or X coordinate where this cell lives, starting from the left<a name="line.17"></a>
<FONT color="green">018</FONT>        * with 1.<a name="line.18"></a>
<FONT color="green">019</FONT>        */<a name="line.19"></a>
<FONT color="green">020</FONT>       private final int x;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>       /**<a name="line.22"></a>
<FONT color="green">023</FONT>        * The row or Y coordinate where this cell lives in the maze, starting from<a name="line.23"></a>
<FONT color="green">024</FONT>        * the top with 1.<a name="line.24"></a>
<FONT color="green">025</FONT>        */<a name="line.25"></a>
<FONT color="green">026</FONT>       private final int y;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>       /**<a name="line.28"></a>
<FONT color="green">029</FONT>        * Sole Constructor.<a name="line.29"></a>
<FONT color="green">030</FONT>        * @param xCoordinate The X/horizontal cell coordinate starting with 1 from<a name="line.30"></a>
<FONT color="green">031</FONT>        *           the left.<a name="line.31"></a>
<FONT color="green">032</FONT>        * @param yCoordinate The Y/vertical cell coordinate starting with 1 from the<a name="line.32"></a>
<FONT color="green">033</FONT>        *           top.<a name="line.33"></a>
<FONT color="green">034</FONT>        * @throws IllegalArgumentException If a given coordinate value is less than<a name="line.34"></a>
<FONT color="green">035</FONT>        *            1.<a name="line.35"></a>
<FONT color="green">036</FONT>        */<a name="line.36"></a>
<FONT color="green">037</FONT>       public MazeCell(int xCoordinate, int yCoordinate)<a name="line.37"></a>
<FONT color="green">038</FONT>       {<a name="line.38"></a>
<FONT color="green">039</FONT>          if (xCoordinate &lt;= 0)<a name="line.39"></a>
<FONT color="green">040</FONT>             throw new IllegalArgumentException("X coordinate must be greater than 0.");<a name="line.40"></a>
<FONT color="green">041</FONT>          if (yCoordinate &lt;= 0)<a name="line.41"></a>
<FONT color="green">042</FONT>             throw new IllegalArgumentException("Y coordinate must be greater than 0.");<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>          this.x = xCoordinate;<a name="line.44"></a>
<FONT color="green">045</FONT>          this.y = yCoordinate;<a name="line.45"></a>
<FONT color="green">046</FONT>       }<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>       /**<a name="line.48"></a>
<FONT color="green">049</FONT>        * Creates a new &lt;code&gt;MazeCell&lt;/code&gt; with its x value changed by the given<a name="line.49"></a>
<FONT color="green">050</FONT>        * amount.<a name="line.50"></a>
<FONT color="green">051</FONT>        */<a name="line.51"></a>
<FONT color="green">052</FONT>       public MazeCell plusX(int x)<a name="line.52"></a>
<FONT color="green">053</FONT>       {<a name="line.53"></a>
<FONT color="green">054</FONT>          return new MazeCell(this.x + x, this.y);<a name="line.54"></a>
<FONT color="green">055</FONT>       }<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>       /**<a name="line.57"></a>
<FONT color="green">058</FONT>        * Creates a new &lt;code&gt;MazeCell&lt;/code&gt; with its y value changed by the given<a name="line.58"></a>
<FONT color="green">059</FONT>        * amount.<a name="line.59"></a>
<FONT color="green">060</FONT>        */<a name="line.60"></a>
<FONT color="green">061</FONT>       public MazeCell plusY(int y)<a name="line.61"></a>
<FONT color="green">062</FONT>       {<a name="line.62"></a>
<FONT color="green">063</FONT>          return new MazeCell(this.x, this.y + y);<a name="line.63"></a>
<FONT color="green">064</FONT>       }<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>       /**<a name="line.66"></a>
<FONT color="green">067</FONT>        * Create a new &lt;code&gt;MazeCell&lt;/code&gt; that has been moved one cell in the<a name="line.67"></a>
<FONT color="green">068</FONT>        * given direction.<a name="line.68"></a>
<FONT color="green">069</FONT>        * @param direction The direction of the neighbor you want.<a name="line.69"></a>
<FONT color="green">070</FONT>        * @return A new cell.<a name="line.70"></a>
<FONT color="green">071</FONT>        */<a name="line.71"></a>
<FONT color="green">072</FONT>       public MazeCell neighbor(Direction direction)<a name="line.72"></a>
<FONT color="green">073</FONT>       {<a name="line.73"></a>
<FONT color="green">074</FONT>          switch (direction)<a name="line.74"></a>
<FONT color="green">075</FONT>          {<a name="line.75"></a>
<FONT color="green">076</FONT>             case North :<a name="line.76"></a>
<FONT color="green">077</FONT>                return this.plusY(-1);<a name="line.77"></a>
<FONT color="green">078</FONT>             case South :<a name="line.78"></a>
<FONT color="green">079</FONT>                return this.plusY(1);<a name="line.79"></a>
<FONT color="green">080</FONT>             case East :<a name="line.80"></a>
<FONT color="green">081</FONT>                return this.plusX(1);<a name="line.81"></a>
<FONT color="green">082</FONT>             case West :<a name="line.82"></a>
<FONT color="green">083</FONT>                return this.plusX(-1);<a name="line.83"></a>
<FONT color="green">084</FONT>             default :<a name="line.84"></a>
<FONT color="green">085</FONT>                throw new IllegalArgumentException("Unkown direction: " + direction);<a name="line.85"></a>
<FONT color="green">086</FONT>          }<a name="line.86"></a>
<FONT color="green">087</FONT>       }<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>       /**<a name="line.89"></a>
<FONT color="green">090</FONT>        * Get the X coordinate.<a name="line.90"></a>
<FONT color="green">091</FONT>        * @return The X coordinate, starting from 1.<a name="line.91"></a>
<FONT color="green">092</FONT>        */<a name="line.92"></a>
<FONT color="green">093</FONT>       public int getX()<a name="line.93"></a>
<FONT color="green">094</FONT>       {<a name="line.94"></a>
<FONT color="green">095</FONT>          return this.x;<a name="line.95"></a>
<FONT color="green">096</FONT>       }<a name="line.96"></a>
<FONT color="green">097</FONT>    <a name="line.97"></a>
<FONT color="green">098</FONT>       /**<a name="line.98"></a>
<FONT color="green">099</FONT>        * Get the Y coordinate.<a name="line.99"></a>
<FONT color="green">100</FONT>        * @return The Y coordinate, starting from 1.<a name="line.100"></a>
<FONT color="green">101</FONT>        */<a name="line.101"></a>
<FONT color="green">102</FONT>       public int getY()<a name="line.102"></a>
<FONT color="green">103</FONT>       {<a name="line.103"></a>
<FONT color="green">104</FONT>          return this.y;<a name="line.104"></a>
<FONT color="green">105</FONT>       }<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>       /**<a name="line.107"></a>
<FONT color="green">108</FONT>        * Get the X coordinate.<a name="line.108"></a>
<FONT color="green">109</FONT>        * @return The X coordinate starting from 0.<a name="line.109"></a>
<FONT color="green">110</FONT>        */<a name="line.110"></a>
<FONT color="green">111</FONT>       public int getXZeroBased()<a name="line.111"></a>
<FONT color="green">112</FONT>       {<a name="line.112"></a>
<FONT color="green">113</FONT>          return this.x - 1;<a name="line.113"></a>
<FONT color="green">114</FONT>       }<a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>       /**<a name="line.116"></a>
<FONT color="green">117</FONT>        * Get the Y coordinate.<a name="line.117"></a>
<FONT color="green">118</FONT>        * @return The Y coordinate starting from 0.<a name="line.118"></a>
<FONT color="green">119</FONT>        */<a name="line.119"></a>
<FONT color="green">120</FONT>       public int getYZeroBased()<a name="line.120"></a>
<FONT color="green">121</FONT>       {<a name="line.121"></a>
<FONT color="green">122</FONT>          return this.y - 1;<a name="line.122"></a>
<FONT color="green">123</FONT>       }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>       /**<a name="line.125"></a>
<FONT color="green">126</FONT>        * Get the x and y coordinates in the form of a &lt;code&gt;Point&lt;/code&gt;.<a name="line.126"></a>
<FONT color="green">127</FONT>        * @return A point with the same coordinates.<a name="line.127"></a>
<FONT color="green">128</FONT>        */<a name="line.128"></a>
<FONT color="green">129</FONT>       public Point getPoint()<a name="line.129"></a>
<FONT color="green">130</FONT>       {<a name="line.130"></a>
<FONT color="green">131</FONT>          return new Point(this.x, this.y);<a name="line.131"></a>
<FONT color="green">132</FONT>       }<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>       /**<a name="line.134"></a>
<FONT color="green">135</FONT>        * Test to see if this maze cell is within the coordinate range of the given<a name="line.135"></a>
<FONT color="green">136</FONT>        * maze dimension. The maze dimension gives the number of columns and rows in<a name="line.136"></a>
<FONT color="green">137</FONT>        * a maze.<a name="line.137"></a>
<FONT color="green">138</FONT>        */<a name="line.138"></a>
<FONT color="green">139</FONT>       public boolean isInRange(Dimension mazeSize)<a name="line.139"></a>
<FONT color="green">140</FONT>       {<a name="line.140"></a>
<FONT color="green">141</FONT>          return (this.x &lt;= mazeSize.width &amp;&amp; this.y &lt;= mazeSize.height);<a name="line.141"></a>
<FONT color="green">142</FONT>       }<a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>       @Override<a name="line.144"></a>
<FONT color="green">145</FONT>       public String toString()<a name="line.145"></a>
<FONT color="green">146</FONT>       {<a name="line.146"></a>
<FONT color="green">147</FONT>          return "(" + this.x + "," + this.y + ")";<a name="line.147"></a>
<FONT color="green">148</FONT>       }<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>       /**<a name="line.150"></a>
<FONT color="green">151</FONT>        * Sorts in order from (x,y) (1,1),(2,1),(3,1),(1,2),(2,2),(3,2). In other<a name="line.151"></a>
<FONT color="green">152</FONT>        * words from left to right, top to bottom.<a name="line.152"></a>
<FONT color="green">153</FONT>        */<a name="line.153"></a>
<FONT color="green">154</FONT>       @Override<a name="line.154"></a>
<FONT color="green">155</FONT>       public int compareTo(MazeCell other)<a name="line.155"></a>
<FONT color="green">156</FONT>       {<a name="line.156"></a>
<FONT color="green">157</FONT>          if (this.y != other.y)<a name="line.157"></a>
<FONT color="green">158</FONT>          {<a name="line.158"></a>
<FONT color="green">159</FONT>             return this.y - other.y;<a name="line.159"></a>
<FONT color="green">160</FONT>          }<a name="line.160"></a>
<FONT color="green">161</FONT>          else<a name="line.161"></a>
<FONT color="green">162</FONT>          { // y's are equal so compare x.<a name="line.162"></a>
<FONT color="green">163</FONT>             return this.x - other.x;<a name="line.163"></a>
<FONT color="green">164</FONT>          }<a name="line.164"></a>
<FONT color="green">165</FONT>       }<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>       @Override<a name="line.167"></a>
<FONT color="green">168</FONT>       public boolean equals(Object obj)<a name="line.168"></a>
<FONT color="green">169</FONT>       {<a name="line.169"></a>
<FONT color="green">170</FONT>          if (obj instanceof MazeCell)<a name="line.170"></a>
<FONT color="green">171</FONT>          {<a name="line.171"></a>
<FONT color="green">172</FONT>             MazeCell other = (MazeCell) obj;<a name="line.172"></a>
<FONT color="green">173</FONT>             if (this.x == other.x &amp;&amp; this.y == other.y)<a name="line.173"></a>
<FONT color="green">174</FONT>             {<a name="line.174"></a>
<FONT color="green">175</FONT>                return true;<a name="line.175"></a>
<FONT color="green">176</FONT>             }<a name="line.176"></a>
<FONT color="green">177</FONT>          }<a name="line.177"></a>
<FONT color="green">178</FONT>          return false;<a name="line.178"></a>
<FONT color="green">179</FONT>       }<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>       @Override<a name="line.181"></a>
<FONT color="green">182</FONT>       public int hashCode()<a name="line.182"></a>
<FONT color="green">183</FONT>       {<a name="line.183"></a>
<FONT color="green">184</FONT>          return this.x | (this.y &lt;&lt; 16); //Merge the 2 coordinates.<a name="line.184"></a>
<FONT color="green">185</FONT>       }<a name="line.185"></a>
<FONT color="green">186</FONT>    <a name="line.186"></a>
<FONT color="green">187</FONT>    }<a name="line.187"></a>




























































</PRE>
</BODY>
</HTML>
